Getting started

To get started, you will need:

  • An understanding of REST API integration development
  • An HTTP client, for example, Postman
  • A Payworks account
  • An API key (go to Authentication below for instructions on how to obtain an API key)
  • A signed Terms of Service agreement

Authentication

To start using the API, you will need:

  • Access to a Payworks API. Visit the Employee API to request a client id and secret
  • A site admin Payworks user account for API login

Contact your service representative if you are interested in getting access to the Payworks API.